.TH "Zebulon::Underwater::SetMotorThrust" 3 "13 Oct 2009" "Version 2" "zebulon" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Zebulon::Underwater::SetMotorThrust \- 
.PP
Command message to set the desired thrust of a motor.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <setmotorthrust.h>\fP
.PP
Inherits \fBZebulon::MCU::Message\fP.
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBMotor\fP { \fBLeft\fP =  0x60, \fBRight\fP =  0x70, \fBVertical\fP =  0x80, \fBHorizontal\fP =  0xFE, \fBAll\fP =  0xFF }"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBSetMotorThrust\fP ()"
.br
.RI "\fIConstructor. \fP"
.ti -1c
.RI "virtual \fB~SetMotorThrust\fP ()"
.br
.RI "\fIDestructor. \fP"
.ti -1c
.RI "virtual int \fBWriteMessageBody\fP (CxUtils::Packet &packet) const "
.br
.RI "\fIWrites the contents of the message payload to the packet. \fP"
.ti -1c
.RI "virtual int \fBReadMessageBody\fP (const CxUtils::Packet &packet)"
.br
.RI "\fIReads the contents of the message payload from the packet, and saves to internal data members. \fP"
.ti -1c
.RI "virtual int \fBSetThrust\fP (Motor motor, double thrust)"
.br
.RI "\fISets member thrust variables. \fP"
.ti -1c
.RI "virtual int \fBSetMotor\fP (Motor motor)"
.br
.ti -1c
.RI "virtual void \fBPrint\fP () const "
.br
.ti -1c
.RI "virtual Message * \fBClone\fP () const "
.br
.RI "\fIMakes a clone of the message. \fP"
.in -1c
.SH "Detailed Description"
.PP 
Command message to set the desired thrust of a motor. 
.SH "Member Function Documentation"
.PP 
.SS "int SetMotorThrust::ReadMessageBody (const CxUtils::Packet & packet)\fC [virtual]\fP"
.PP
Reads the contents of the message payload from the packet, and saves to internal data members. \fBParameters:\fP
.RS 4
\fIpacket\fP Packet to read from.
.RE
.PP
\fBReturns:\fP
.RS 4
4 on success, 0 on failure. 
.RE
.PP

.PP
Reimplemented from \fBZebulon::MCU::Message\fP.
.SS "int SetMotorThrust::SetThrust (Motor motor, double thrust)\fC [virtual]\fP"
.PP
Sets member thrust variables. \fBParameters:\fP
.RS 4
\fImotor\fP Motor enum of the motors you wish to set thrust to
.br
\fIthrust\fP Thrust value as a percentage [-100,100]
.RE
.PP
\fBReturns:\fP
.RS 4
1 on success, 0 on failure. 
.RE
.PP

.SS "int SetMotorThrust::WriteMessageBody (CxUtils::Packet & packet) const\fC [virtual]\fP"
.PP
Writes the contents of the message payload to the packet. \fBParameters:\fP
.RS 4
\fIpacket\fP Packet to write to.
.RE
.PP
\fBReturns:\fP
.RS 4
4 on success, 0 on failure. 
.RE
.PP

.PP
Reimplemented from \fBZebulon::MCU::Message\fP.

.SH "Author"
.PP 
Generated automatically by Doxygen for zebulon from the source code.
